cs-nequi-sapi
📘 API Documentation - cs-nequi-sapi
Este documento proporciona la estructura y el uso de cs-nequi-sapi, una API de Sistema diseñada para procesar pagos usando Nequi.
💂️ Información Base
- Título de la API: cs-nequi-sapi
- Versión: 1.0.0
- URL Base:
https://cs-nequi-sapi-{env}.us-e1.cloudhub.io/api/
Reemplaza {env} con:
dev(Desarrollo)qa(Aseguramiento de Calidad)prod(Producción)
🔑 Autenticación
Encabezados Requeridos
| Encabezado | Tipo | Descripción |
|---|---|---|
| Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
| client_id | String | Identificador único para clientes de la API |
Authorization
- Longitud: 36 - 37 caracteres
- Ejemplo:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
📌 Estos encabezados son obligatorios en todas las solicitudes.
🧾 Enlace de Exchange
📎 Enlace RAML de Exchange (temporal):
https://anypoint.mulesoft.com/exchange/placeholder-link-for-cs-nequi-sapi
🗺️ Diagrama
✨ Endpoint: Iniciar Pago No Registrado
POST /payments/unregistered
- Descripción: Inicia un pago desde un usuario no registrado.
Ejemplo de Solicitud
📄 examples/requests/post-payments-unregistered.json
Ejemplo de Respuesta
📄 examples/responses/post-payments-unregistered.json
📌 Endpoint: Estado del Pago (No Registrado)
POST /payments/unregistered/status
- Descripción: Consulta el estado de un pago no registrado previamente iniciado.
Documentación
📄 documentation/post-payments-unregistered-status.md
Ejemplo de Solicitud
📄 examples/requests/post-payments-unregistered-status.json
Ejemplo de Respuesta
📄 examples/responses/post-payments-unregistered-status.json
🔁 Endpoint: Reversar Pago (No Registrado)
POST /payments/unregistered/reverse
- Descripción: Reversa una transacción de pago no registrado.
Ejemplo de Solicitud
📄 examples/requests/post-payments-unregistered-reverse.json
Ejemplo de Respuesta
📄 examples/responses/post-payments-unregistered-reverse.json
❌ Endpoint: Cancelar Pago (No Registrado)
POST /payments/unregistered/cancel
- Descripción: Cancela una transacción de pago no registrado.
Ejemplo de Solicitud
📄 examples/requests/post-payments-unregistered-cancel.json
Ejemplo de Respuesta
📄 examples/responses/post-payments-unregistered-cancel.json
🔐 Esquemas de Seguridad
Validación de Client ID
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
| client_id | String | ✅ | 32 - 36 | [a-zA-Z0-9] |
| client_secret | String | ✅ | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
| Authorization | String | ✅ | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 400 | Solicitud Incorrecta | Verifica el formato de la solicitud y parámetros. |
| 401 | No Autorizado | Revisa las credenciales de autenticación. |
| 404 | No Encontrado | Asegúrate de que la URL del endpoint sea correcta. |
| 500 | Error Interno del Servidor | Reintenta o contacta soporte si persiste. |
📞 Soporte
Para preguntas o ayuda, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo: epalma@fgs.co
Última actualización: Septiembre 2025